Fetch

Customer​

Endpoints
POST/customersGET/customersGET/customers/{reference}POST/customers/{reference}DELETE/customers/{reference}GET/customers/{reference}/payment_methodsPATCH/customers/{reference}/blockPATCH/customers/{reference}/unblock

Fetch​

This endpoint retrieves the details of a specific customer using their reference ID.

Path Parameters
  • reference
    required
    string

    Customer id

Responses
  • 200

    Successful response

GET/customers/{reference}
Shell cURL
curl --request GET \
  --url https://api.notchpay.co/customers/__REFERENCE__
No Body

Successful response

Update​

This endpoint allows you to update the information of a specific customer.

Path Parameters
  • reference
    required
    string
Body
application/json
object
Example{ "email": "Melany.Breitenberg@gmail.com", "name": "Andrew Breitenberg", "phone": "237656019262", "metadata": { "field_name": "Illo amet sit et rerum id totam aspernatur." }, "address": { "country": "US", "state": "Region name", "city": "Jeromyburgh", "postal_code": "00237", "address_line1": "44451 Howell Loaf", "address_line2": "825 Paula Forest" }, "billing": { "country": "CV", "state": "Region name", "city": "Welchside", "postal_code": "00237", "address_line1": "9438 Ezequiel Hills", "address_line2": "7851 Zelda Corner" } }
Responses
  • 200

    Successful response

  • 401

    Unauthorized

POST/customers/{reference}
Shell cURL
curl --request POST \
  --url https://api.notchpay.co/customers/__REFERENCE__ \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "Melany.Breitenberg@gmail.com",
  "name": "Andrew Breitenberg",
  "phone": "237656019262",
  "metadata": {
    "field_name": "Illo amet sit et rerum id totam aspernatur."
  },
  "address": {
    "country": "US",
    "state": "Region name",
    "city": "Jeromyburgh",
    "postal_code": "00237",
    "address_line1": "44451 Howell Loaf",
    "address_line2": "825 Paula Forest"
  },
  "billing": {
    "country": "CV",
    "state": "Region name",
    "city": "Welchside",
    "postal_code": "00237",
    "address_line1": "9438 Ezequiel Hills",
    "address_line2": "7851 Zelda Corner"
  }
}'
No Body

Successful response

2.0.0
OAS 3.1.0

API Reference

The Notch Pay API is designed to provide you with a simple and powerful integration with our payment platform. Here are the fundamental principles that guide our API:

RESTful Architecture

Our API is built on the REST (Representational State Transfer) architecture, providing you with intuitive and predictable URLs for interacting with Notch Pay resources (payments, customers, transactions, etc.).

Request and Response Format

Requests: Requests are sent in the application/json format for maximum compatibility. Responses: All responses are returned in JSON format, clearly structured for easy processing in your application.

Standard HTTP Response Codes

We use standard HTTP response codes to indicate the success or failure of requests, providing you with accurate information about the outcome of each interaction.

Secure Authentication

Authentication is ensured through unique API keys that you obtain when you sign up. These keys ensure that only authorized applications can access your Notch Pay account.

Test Mode

Our API offers a comprehensive test mode that allows you to develop and test your integration without affecting your live data or interacting with banking networks.

Continuous Evolution

We regularly update our API with new features and improvements. Check our documentation regularly to stay informed about the latest developments.

Individual Resources

Our API handles resources individually. Each request should focus on a single resource at a time to ensure the consistency and reliability of operations.

Ready to get started? Explore our detailed integration guides and comprehensive API references to start accepting payments seamlessly with Notch Pay.

Additional Key Points to Consider for Your Notch Pay Documentation:

Code Examples: Provide concrete code examples in different languages to help developers quickly integrate the API.

Support Channels: Clearly indicate how developers can get help if needed (email, forum, etc.).

Client Libraries
Shell
Ruby
Node.js
PHP
Python
More
cURL Shell

Customer​

Endpoints
POST/customersGET/customersGET/customers/{reference}POST/customers/{reference}DELETE/customers/{reference}GET/customers/{reference}/payment_methodsPATCH/customers/{reference}/blockPATCH/customers/{reference}/unblock

Create​

Create a new client profile within your system's integration.

Headers
  • Accept
    string
  • Content-Type
    string
Body
application/json
email
required
email
max: 
240

The email address of the customer is prominently displayed within your dashboard, and serves as a valuable tool for both search and tracking purposes.

phone
required
string

The customer’s phone number.

name
string
max: 
128

The customer’s full name or business name.

address
object

Billing address

shipping
object

Shipping address

Responses
  • 201

    Successful response

  • 401

    Unauthorized

  • 422

    Validation error

POST/customers
Shell cURL
curl --request POST \
  --url https://api.notchpay.co/customers \
  --header 'Content-Type: application/json' \
  --data '{
  "email": null,
  "phone": "",
  "address": {
    "country": ""
  },
  "shipping": {
    "country": ""
  }
}'
No Body

Successful response